Kotlin Computational Geometry/io.github.cponfick.kompgeom.algorithms/IAlgorithm/IAlgorithmInfo

IAlgorithmInfo

interface IAlgorithmInfo(source)

Companion interface that defines static-like functions that implementations should provide. Implementing classes should have a companion object that implements this interface. To provide the user with useful meta-information about the algorithm, such as its name, group, time complexity, and space complexity.

Inheritors

Functions

Link copied to clipboard
abstract fun getGroup(): String

Returns the group to which the algorithm belongs. This is used for categorization and organization of algorithms.

Link copied to clipboard
open fun getId(): String

Returns a unique identifier for the algorithm, combining its group and name. The identifier is formatted as "group:name", with both group and name in lowercase and spaces replaced by hyphens.

Link copied to clipboard
abstract fun getName(): String

Returns the static name of the algorithm implementation.

Link copied to clipboard
abstract fun getSpaceComplexity(): String

Returns the space complexity of the algorithm.

Link copied to clipboard
abstract fun getTimeComplexity(): String

Returns the time complexity of the algorithm.